pp108 : CWS Command-line Tool - MoveSynchronizerLocation

CWS Command-line Tool - MoveSynchronizerLocation

This topic describes the CWS command-line tool called MoveSynchronizerLocation.

The command line tool MoveSynchronizerLocation is used to change the location of the Collaborative Workspace (CWS) synchronization folder in an automated way. This affects the synchronization location of all the workspaces in the Process Platform instance. When running the tool, first all CWS service containers are stopped to prevent changing the synchronization folder while someone is still developing content in one of the workspaces. There may be multiple CWS service containers in case of load balancing. After running the tool, all the CWS service containers must be restarted manually.

Note: The MoveSynchronizerLocation tool does not change the location of the build folder; if required, you must change it manually.

The command-line tool MoveSynchronizerLocation accepts two parameters:

MoveSynchronizerLocation DESTINATION [-skipConfiguration]

where,

  • DESTINATION is the new synchronization directory
  • -skipConfiguration is an optional parameter. When this parameter is provided, the CWS configuration file, located at <install directory>/components/cws/config/cws.properties, will not be updated.

If you run the MoveSynchronizerLocation tool with the optional paramater -skipConfiguration, the mentioned configuration file will not be updated. In that case, the old synchronization directory will be used again. To make the changes effective in this case, the configuration file must be updated manually.

For example, changing the synchronization directory to E:\temp\cws\sync can be done by running the following command:

MoveSynchronizerLocation E:\temp\cws\sync

Note: In case the path of the destination directory contains white space characters, the path must be included in double quotes as shown below:

MoveSynchronizerLocation "E:\temp\cws\sync folder\"

Note: The operating system user account under which the platform operates must have full permissions for the new synchronization directory.